package com.lpinfo.spb.config.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
                .apiInfo(apiInfo())
                .select()
                //如果某个接口不想暴露,可以使用以下注解@ApiIgnore 这样该接口就不会暴露在 swagger2
                .apis(RequestHandlerSelectors.basePackage("com.lpinfo.spb.plateform"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("良品信息 接口平台")
                //条款地址
                .termsOfServiceUrl("http://lpinfo-spb-fast.lpinfo.top/")
                //version info
                .version("V1.0")
                //描述
                .description("良品信息 lpinfo-spb-fast 开放API")
                .build();
    }
}
